/*
 * Copyright (c) 2012-2013 Open Source Community - <http://www.peerfact.org>
 * Copyright (c) 2011-2012 University of Paderborn - UPB
 * Copyright (c) 2005-2011 KOM - Multimedia Communications Lab
 *
 * This file is part of PeerfactSim.KOM.
 * 
 * PeerfactSim.KOM is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 * 
 * PeerfactSim.KOM is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with PeerfactSim.KOM.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package org.peerfact.impl.overlay.dht.centralizedindex.messages;

import org.peerfact.api.common.Message;
import org.peerfact.impl.overlay.AbstractOverlayMessage;
import org.peerfact.impl.overlay.dht.centralizedindex.components.CIOverlayID;

/**
 * Implementing a centralized DHT overlay, whose organization of the centralized
 * index is similar to the distributed index of Chord
 * 
 * @author Dominik Stingl <peerfact@kom.tu-darmstadt.de>
 * @version 1.0, 08.12.2008
 */
public abstract class AbstractCIReplyMsg<S extends Object> extends
		AbstractOverlayMessage<CIOverlayID> {

	/**
	 * 
	 */
	private static final long serialVersionUID = -2852122456309140159L;

	private int opID;

	private S result;

	private long size;

	public AbstractCIReplyMsg(CIOverlayID sender,
			CIOverlayID receiver, S result, int opID) {
		super(sender, receiver);
		this.result = result;
		this.opID = opID;
		this.size = sender.getTransmissionSize()
				+ receiver.getTransmissionSize();
	}

	public int getOpID() {
		return opID;
	}

	@Override
	public long getSize() {
		return size;
	}

	public S getResult() {
		return this.result;
	}

	@Override
	public String toString() {
		return "" + getClass().getSimpleName() + "(" + getReceiver() + " -> "
				+ getSender() + "; result= " + this.result + ")";
	}

	@Override
	public Message getPayload() {
		return null;
	}

}
